Skip to content

feat(js): Update web worker guide with new webWorkerIntegration APIs #14395

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Jul 22, 2025
Merged

feat(js): Update web worker guide with new webWorkerIntegration APIs #14395

merged 4 commits into from
Jul 22, 2025

Conversation

Lms24
Copy link
Member

@Lms24 Lms24 commented Jul 17, 2025 •
edited
Loading

DESCRIBE YOUR PR

closes getsentry/sentry-javascript#16977
closes getsentry/sentry-javascript#16974

This PR adds documentation for two new WebWorker-related APIs:

  • Sentry.webWorkerIntegration()
  • Sentry.registerWebWorker()

More details in getsentry/sentry-javascript#16981

I also gave the entire web worker guide a facelift, removed some unnecessary notSupported platforms and added an integration page for the new integration. Also, the guide now includes a paragraph about configuring Vite correctly for worker builds which was raised in getsentry/sentry-javascript-bundler-plugins#755.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+ (only to be merged after 9.40.0 was released)

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

@vercel Vercel
Copy link

vercel bot commented Jul 17, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 22, 2025 4:16pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored (Inspect) Visit Preview Jul 22, 2025 4:16pm

@Lms24 Lms24 requested review from timfish and AbhiPrasad July 17, 2025 12:55
@Lms24 Lms24 self-assigned this Jul 17, 2025
@codecov Codecov
Copy link

codecov bot commented Jul 17, 2025 •
edited
Loading

Bundle Report

Changes will increase total bundle size by 2.59kB (0.01%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-client-array-push 9.84MB -6 bytes (-0.0%) ⬇️
sentry-docs-server-cjs 11.97MB 2.6kB (0.02%) ⬆️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.67MB -0.0%
../instrumentation.js -3 bytes 999.78kB -0.0%
9523.js -3 bytes 975.72kB -0.0%
../app/[[...path]]/page.js.nft.json 868 bytes 719.3kB 0.12%
../app/platform-redirect/page.js.nft.json 868 bytes 719.21kB 0.12%
../app/sitemap.xml/route.js.nft.json 868 bytes 717.18kB 0.12%
view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 881.08kB -0.0%
static/chunks/1831-*.js -3 bytes 423.46kB -0.0%
server/middleware-*.js 5.55kB 6.55kB 555.3% ⚠️
server/middleware-*.js -5.55kB 1.0kB -84.74%
static/LDd7U_S8B1z6cXZePn_Oa/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/LDd7U_S8B1z6cXZePn_Oa/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/PL_pBlecn4JtouY8n5u2B/_buildManifest.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/PL_pBlecn4JtouY8n5u2B/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

coolguyzone
coolguyzone reviewed Jul 21, 2025
View reviewed changes
coolguyzone
coolguyzone reviewed Jul 21, 2025
View reviewed changes
coolguyzone
coolguyzone reviewed Jul 21, 2025
View reviewed changes
coolguyzone
coolguyzone reviewed Jul 21, 2025
View reviewed changes
coolguyzone
coolguyzone reviewed Jul 21, 2025
View reviewed changes
coolguyzone
coolguyzone approved these changes Jul 21, 2025
View reviewed changes
Copy link
Contributor

@coolguyzone coolguyzone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some feedback, overall looks good, thanks for adding!

Lms24 and others added 2 commits July 22, 2025 17:46
@Lms24 @coolguyzone
Apply suggestions from code review
bc2f8f9 
Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io>
@Lms24
rewording
ccbd7a1
@Lms24 Lms24 enabled auto-merge (squash) July 22, 2025 15:50
cursor[bot]
cursor bot reviewed Jul 22, 2025
View reviewed changes
Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Incorrect Plugin Configuration Causes Runtime Error

The worker.plugins configuration incorrectly uses the spread operator (...sentryPlugin) on sentryPlugin, which is a single, non-iterable plugin object. This will cause a runtime error. The correct usage is [sentryPlugin].

docs/platforms/javascript/common/best-practices/web-workers.mdx#L175-L176

sentry-docs/docs/platforms/javascript/common/best-practices/web-workers.mdx

Lines 175 to 176 in ccbd7a1

// Vite plugin for worker bundle
plugins: () => [...sentryPlugin],

Fix in Cursor • Fix in Web

Was this report helpful? Give feedback by reacting with 👍 or 👎

@Lms24
Copy link
Member Author

Lms24 commented Jul 22, 2025

lol Cursor, do you even read bro?

@Lms24 Lms24 merged commit 3c0e175 into master Jul 22, 2025
12 checks passed
@Lms24 Lms24 deleted the lms/feat-js-web-worker-docs branch July 22, 2025 16:16
lucas-zimerman pushed a commit that referenced this pull request Jul 29, 2025
@Lms24 @coolguyzone @lucas-zimerman
feat(js): Update web worker guide with new webWorkerIntegration APIs (
1fcc0ef 
#14395)

<!-- Use this checklist to make sure your PR is ready for merge. You may
delete any sections you don't need. -->

## DESCRIBE YOUR PR

closes getsentry/sentry-javascript#16977
closes getsentry/sentry-javascript#16974

This PR adds documentation for two new `WebWorker`-related APIs:
- `Sentry.webWorkerIntegration()`
- `Sentry.registerWebWorker()`

More details in
getsentry/sentry-javascript#16981

I also gave the entire web worker guide a facelift, removed some
unnecessary `notSupported` platforms and added an integration page for
the new integration. Also, the guide now includes a paragraph about
configuring Vite correctly for worker builds which was raised in
getsentry/sentry-javascript-bundler-plugins#755.


## IS YOUR CHANGE URGENT?  

Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE -->
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [x] None: Not urgent, can wait up to 1 week+ (only to be merged after
9.40.0 was released)

## SLA

- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!

## PRE-MERGE CHECKLIST

*Make sure you've checked the following before merging your changes:*

- [x] Checked Vercel preview for correctness, including links
- [x] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)

## LEGAL BOILERPLATE

<!-- Sentry employees and contractors can delete or ignore this section.
-->

Look, I get it. The entity doing business as "Sentry" was incorporated
in the State of Delaware in 2015 as Functional Software, Inc. and is
gonna need some rights from me in order to utilize my contributions in
this here PR. So here's the deal: I retain all rights, title and
interest in and to my contributions, and by keeping this boilerplate
intact I confirm that Sentry can use, modify, copy, and redistribute my
contributions, under Sentry's choice of terms.

## EXTRA RESOURCES

- [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)

---------

Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io>
@github-actions github-actions bot locked and limited conversation to collaborators Aug 7, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@cursor cursor[bot] cursor[bot] left review comments

@timfish timfish timfish approved these changes

@AbhiPrasad AbhiPrasad AbhiPrasad approved these changes

@coolguyzone coolguyzone coolguyzone approved these changes

Assignees

@Lms24 Lms24

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update docs + document how to configure source maps upload Support and assign debugIds from web worker in main thread
4 participants
@Lms24 @timfish @AbhiPrasad @coolguyzone